<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<link rel="STYLESHEET" href="lib.css" type='text/css' />
<link rel="SHORTCUT ICON" href="../icons/pyfav.png" type="image/png" />
<link rel='start' href='../index.html' title='Python documentation Index' />
<link rel="first" href="lib.html" title='Python library Reference' />
<link rel='contents' href='contents.html' title="Contents" />
<link rel='index' href='genindex.html' title='Index' />
<link rel='last' href='about.html' title='About this document...' />
<link rel='help' href='about.html' title='About this document...' />
<link rel="next" href="module-runpy.html" />
<link rel="prev" href="module-pkgutil.html" />
<link rel="parent" href="modules.html" />
<link rel="next" href="module-runpy.html" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name='aesop' content='information' />
<title>29.4 modulefinder -- Find modules used by a script</title>
</head>
<body>
<div class="navigation">
<div id='top-navigation-panel' xml:id='top-navigation-panel'>
<table align="center" width="100%" cellpadding="0" cellspacing="2">
<tr>
<td class='online-navigation'><a rel="prev" title="29.3 pkgutil  "
  href="module-pkgutil.html"><img src='../icons/previous.png'
  border='0' height='32'  alt='Previous Page' width='32' /></a></td>
<td class='online-navigation'><a rel="parent" title="29. importing Modules"
  href="modules.html"><img src='../icons/up.png'
  border='0' height='32'  alt='Up one Level' width='32' /></a></td>
<td class='online-navigation'><a rel="next" title="29.5 runpy  "
  href="module-runpy.html"><img src='../icons/next.png'
  border='0' height='32'  alt='Next Page' width='32' /></a></td>
<td align="center" width="100%">Python Library Reference</td>
<td class='online-navigation'><a rel="contents" title="Table of Contents"
  href="contents.html"><img src='../icons/contents.png'
  border='0' height='32'  alt='Contents' width='32' /></a></td>
<td class='online-navigation'><a href="modindex.html" title="Module Index"><img src='../icons/modules.png'
  border='0' height='32'  alt='Module Index' width='32' /></a></td>
<td class='online-navigation'><a rel="index" title="Index"
  href="genindex.html"><img src='../icons/index.png'
  border='0' height='32'  alt='Index' width='32' /></a></td>
</tr></table>
<div class='online-navigation'>
<b class="navlabel">Previous:</b>
<a class="sectref" rel="prev" href="module-pkgutil.html">29.3 pkgutil  </a>
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="modules.html">29. Importing Modules</a>
<b class="navlabel">Next:</b>
<a class="sectref" rel="next" href="module-runpy.html">29.5 runpy  </a>
</div>
<hr /></div>
</div>
<!--End of Navigation Panel-->

<h1><a name="SECTION0031400000000000000000">
29.4 <tt class="module">modulefinder</tt> --
         Find modules used by a script</a>
</h1>

<p>
<a name="module-modulefinder"></a>

<p>

<span class="versionnote">New in version 2.3.</span>

<p>
This module provides a <tt class="class">ModuleFinder</tt> class that can be used to
determine the set of modules imported by a script.
<code>modulefinder.py</code> can also be run as a script, giving the
filename of a Python script as its argument, after which a report of
the imported modules will be printed.

<p>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-5399' xml:id='l2h-5399' class="function">AddPackagePath</tt></b>(</nobr></td>
  <td><var>pkg_name, path</var>)</td></tr></table></dt>
<dd>
Record that the package named <var>pkg_name</var> can be found in the specified <var>path</var>.
</dl>

<p>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-5400' xml:id='l2h-5400' class="function">ReplacePackage</tt></b>(</nobr></td>
  <td><var>oldname, newname</var>)</td></tr></table></dt>
<dd>
Allows specifying that the module named <var>oldname</var> is in fact
the package named <var>newname</var>.  The most common usage would be 
to handle how the <tt class="module">_xmlplus</tt> package replaces the <tt class="module">xml</tt>
package.
</dl>

<p>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><span class="typelabel">class</span>&nbsp;<tt id='l2h-5401' xml:id='l2h-5401' class="class">ModuleFinder</tt></b>(</nobr></td>
  <td><var></var><big>[</big><var>path=None, debug=0, excludes=[], replace_paths=[]</var><big>]</big><var></var>)</td></tr></table></dt>
<dd>

<p>
This class provides <tt class="method">run_script()</tt> and <tt class="method">report()</tt>
methods to determine the set of modules imported by a script.
<var>path</var> can be a list of directories to search for modules; if not
specified, <code>sys.path</code> is used. 
<var>debug</var> sets the debugging level; higher values make the class print 
debugging messages about what it's doing.
<var>excludes</var> is a list of module names to exclude from the analysis.
<var>replace_paths</var> is a list of <code>(<var>oldpath</var>, <var>newpath</var>)</code>
tuples that will be replaced in module paths.
</dl>

<p>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-5402' xml:id='l2h-5402' class="method">report</tt></b>(</nobr></td>
  <td><var></var>)</td></tr></table></dt>
<dd>
Print a report to standard output that lists the modules imported by the script
and their
paths, as well as modules that are missing or seem to be missing.
</dl>

<p>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-5403' xml:id='l2h-5403' class="method">run_script</tt></b>(</nobr></td>
  <td><var>pathname</var>)</td></tr></table></dt>
<dd>
Analyze the contents of the <var>pathname</var> file, which must contain 
Python code.
</dl>

<p>

<div class="navigation">
<div class='online-navigation'>
<p></p><hr />
<table align="center" width="100%" cellpadding="0" cellspacing="2">
<tr>
<td class='online-navigation'><a rel="prev" title="29.3 pkgutil  "
  href="module-pkgutil.html"><img src='../icons/previous.png'
  border='0' height='32'  alt='Previous Page' width='32' /></a></td>
<td class='online-navigation'><a rel="parent" title="29. importing Modules"
  href="modules.html"><img src='../icons/up.png'
  border='0' height='32'  alt='Up one Level' width='32' /></a></td>
<td class='online-navigation'><a rel="next" title="29.5 runpy  "
  href="module-runpy.html"><img src='../icons/next.png'
  border='0' height='32'  alt='Next Page' width='32' /></a></td>
<td align="center" width="100%">Python Library Reference</td>
<td class='online-navigation'><a rel="contents" title="Table of Contents"
  href="contents.html"><img src='../icons/contents.png'
  border='0' height='32'  alt='Contents' width='32' /></a></td>
<td class='online-navigation'><a href="modindex.html" title="Module Index"><img src='../icons/modules.png'
  border='0' height='32'  alt='Module Index' width='32' /></a></td>
<td class='online-navigation'><a rel="index" title="Index"
  href="genindex.html"><img src='../icons/index.png'
  border='0' height='32'  alt='Index' width='32' /></a></td>
</tr></table>
<div class='online-navigation'>
<b class="navlabel">Previous:</b>
<a class="sectref" rel="prev" href="module-pkgutil.html">29.3 pkgutil  </a>
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="modules.html">29. Importing Modules</a>
<b class="navlabel">Next:</b>
<a class="sectref" rel="next" href="module-runpy.html">29.5 runpy  </a>
</div>
</div>
<hr />
<span class="release-info">Release 2.5.1, documentation updated on 18th April, 2007.</span>
</div>
<!--End of Navigation Panel-->
<address>
See <i><a href="about.html">About this document...</a></i> for information on suggesting changes.
</address>
</body>
</html>
